Getting Started with Imports

Overview

The Loyalty platform supports two data import features: Standard Imports and Advanced Imports. This article describes Advanced Imports. For more information on the differences between the two import features, see Importing Data into Loyalty.

Loyalty allows you to use the Advanced Import feature to import data into several different tables, including Members, Offers, Offer Certificates, and Orders, for example.

The Advanced Import feature utilizes a reusable asset called an Import Definition.

The Import Definition controls the content of the import. You can select exactly what fields to import, and in what sequence, by mapping columns in the import file to fields in the destination table. You can also transform the data directly within the Import Definition.

The Import Definition also controls the origin of the import file, such as your local PC or an external server (Secure FTP, Amazon S3, or Google Cloud Storage). You can also define the import file properties, such as the delimiter character, use of a header row, use of encryption, and so forth.

Import files coming from an external server require the use of a Connector. Connectors are used to integrate Loyalty with other platforms. Connectors contain the information needed to manage that integration, such as API endpoints, login credentials, etc. The collection of settings and properties are saved as a reusable asset called a Connection Profile. For more information, see Connectors.

In addition, the Import Definition controls the schedule of the import. You can schedule an Import Definition to execute at a specific date and time, or on a recurring basis.

Control Files

When importing data into Loyalty through the Advanced Import feature, the platform supports the optional use of a Control File as a way to validate that the import file has been received correctly. If enabled, the Control File must be provided along with the import file. The Control File should contain one row and one column (without a header row). The value in the Control File must be an integer that represents the expected record count of the import file (including a column header row, if used).

Loyalty will count the records in the import file, and compare that count to the integer in the Control File. If the platform identifies a discrepancy in the record count, the import process is stopped, and the platform displays an error message.

The Control File must conform to the proper naming convention so that the platform can identify the import file to which it corresponds. The Control File must have the exact same name as the import file, but with a file extension of "control" or "ctrl." For example:

  • Import File Name: member_import_20200821.txt

  • Control File Name: member_import_20200821.control

If you zip the import file, you must also zip its corresponding Control File. For example:

  • Zipped Import File: member_import_20200821.zip

  • Zipped Control File: member_import_20200821.control.zip

If you encrypt the import file, you must also encrypt its corresponding Control File. For example:

  • Encrypted Import File: member_import_20200821.pgp

  • Encrypted Control File: member_import_20200821.control.pgp

Loyalty allows you to optionally treat multiple import files as a single import job. If you have this feature enabled, all files must pass the Control File evaluation criteria, or else the import will fail for all files. If you do not have this feature enabled, the platform evaluates each import file separately against its Control File.

If importing multiple files, you can optionally zip all import files together in one file, and zip all their corresponding Control Files in another zip file. For example:

  • Import Files: all_import_files_20200821.zip

  • Control Files: all_control_files_20200821.control.zip

Access

The Imports screen displays a list of Import Definitions in your account. To access the Imports screen, select Admin from the top navigation bar, then select Integrations > Imports from the side navigation menu.

For more information on the search options available on the Imports screen, please see Search for an Import Definition.

 Create an Import Definition Configure an Import Definition Execute an Import Definition